A tiny wrapper that sits around your request function that caches its data for a specified duration, provides updates as requested rather than polling each interval
A tiny wrapper that sits around your request function that caches its data for a specified duration, provides updates as requested rather than polling each interval
// Import cachely
import Cachely from 'cachely'
// For our retriever, have a locally scoped variable that will showcase the caching
let fetches = 0
// Create the wrapper retriever in the cachely cache service
const cachely = new Cachely({
// The method that will fetch the data
retrieve() {
return new Promise(function (resolve) {
// after a one second delay, return the number of fetches that we have done
setTimeout(() => resolve(++fetches), 1000)
})
},
// An optional duration in milliseconds that our cache of the data will be valid for
// When expired, on the next request of the data, we will use the method to get the latest data
// Defaults to one day
duration: 2000, // in this example we set it to two seconds
// An optional function that receives debugging log messages
// Defaults to nothing
log: console.log,
})
// do an initial fetch of the data
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after one second as specified in our method, the result data should still be 1:',
),
)
// do a subsequent fetch of the data that will be from the cache
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after a tiny delay this will be from cache, the result data should still be 1:',
),
)
// wait 3000ms for the cache to invalidate itself
setTimeout(function () {
// do a second fetch of the data
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after one second as specified in our method, the result data should be 2, as it was our second fetch:',
),
)
// do a subsequent fetch of the data that will be from the cache
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after a tiny delay this will be from cache, the result data should still be 2:',
),
)
// peform a manual invalidation
cachely.invalidate()
// do a third fetch of the data
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after one second as specified in our method, the result data should be 3, as it was our third fetch:',
),
)
// do a subsequent fetch of the data that will be from the cache
cachely
.resolve()
.catch(console.error)
.then(
console.log.bind(
console,
'after a tiny delay this will be from cache, the result data should still be 3:',
),
)
}, 3000)
npm install --save cachelyimport pkg from ('cachely')const pkg = require('cachely').defaultimport pkg from 'https://unpkg.com/cachely@^6.8.0/edition-deno/index.ts'
<script type="module">
import pkg from '//cdn.skypack.dev/cachely@^6.8.0'
</script>
<script type="module">
import pkg from '//unpkg.com/cachely@^6.8.0'
</script>
<script type="module">
import pkg from '//dev.jspm.io/cachely@6.8.0'
</script>
This package is published with the following editions:
cachely aliases cachely/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentcachely/source/index.ts is TypeScript source code with Import for modulescachely/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modulescachely/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Require for modulescachely/edition-es2016/index.js is TypeScript compiled against ES2016 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulescachely/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulescachely/edition-types/index.d.ts is TypeScript compiled Types with Import for modulescachely/edition-deno/index.ts is TypeScript source code made to be compatible with DenoDiscover the release history by heading on over to the HISTORY.md file.
Discover how to contribute via the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
FAQs
A tiny wrapper that sits around your request function that caches its data for a specified duration, provides updates as requested rather than polling each interval
We found that cachely demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.